LanguageExt.Core ► Monads ► State and Environment Monads ► Writer ► Writer

Contents

Writer <W, A> (Func<W, (A Value, W Output)> runWriter)

Pure (A value)
Write ((A Value, W Output) result)
Write (A value, W output)
Listen ()
Listens (Func<W, B> f)
Censor (Func<W, W> f)
Lift (Pure<A> monad)
Lift (Func<A> f)
Map (Func<A, B> f)
Select (Func<A, B> f)
Bind (Func<A, K<Writer<W>, B>> f)
Bind (Func<A, Writer<W, B>> f)
Bind (Func<A, Tell<W>> f)
SelectMany <B, C> (Func<A, K<Writer<W>, B>> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, Writer<W, B>> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, Pure> bind, Func<A, B, C> project)
SelectMany <C> (Func<A, Tell<W>> bind, Func<A, Unit, C> project)
Run ()

WriterExtensions

As <W, A> (this K<Writer<W>, A> ma)
Flatten <W, A> (this Writer<W, Writer<W, A>> mma)

Writer <W>

Pure <A> (A value)

Writer

Pure <W, A> (A value)
bind <W, A, B> (Writer<W, A> ma, Func<A, Writer<W, B>> f)
map <W, A, B> (Func<A, B> f, Writer<W, A> ma)
apply <W, A, B> (Writer<W, Func<A, B>> mf, Writer<W, A> ma)
action <W, A, B> (Writer<W, A> ma, Writer<W, B> mb)
tell <W> (W item)
write <W, A> ((A, W) item)
write <W, A> (A value, W item)
pass <W, A> (Writer<W, (A Value, Func<W, W> Function)> action)
listen <W, A> (Writer<W, A> ma)
listens <W, A, B> (Func<W, B> f, Writer<W, A> ma)
censor <W, A> (Func<W, W> f, Writer<W, A> ma)

Writer <W>

Prelude

tell <W> (W item)
write <W, A> ((A, W) item)
write <W, A> (A value, W item)
pass <W, A> (Writer<W, (A Value, Func<W, W> Function)> action)
listen <W, A> (Writer<W, A> ma)
listens <W, A, B> (Func<W, B> f, Writer<W, A> ma)
censor <W, A> (Func<W, W> f, Writer<W, A> ma)

record Writer <W, A> (Func<W, (A Value, W Output)> runWriter) Source #

where W : Monoid<W>

Writer monad transformer, which adds a modifiable state to a given monad.

Parameters

type	S	State type
type	M	Given monad trait
type	A	Bound value type
param	runState	Transducer that represents the transformer operation

Methods

method Writer<W, A> Pure (A value) Source #

Lift a pure value into the monad-transformer

Parameters

param	value	Value to lift
returns	`Writer`

method Writer<W, A> Write ((A Value, W Output) result) Source #

Construct a writer computation from a (result, output) pair.

The inverse of Run()

Parameters

param

result

Result / Output pair

method Writer<W, A> Write (A value, W output) Source #

Construct a writer computation from a (result, output) pair.

The inverse of Run()

Parameters

param

result

Result / Output pair

method Writer<W, (A Value, W Output)> Listen () Source #

Writes an item and returns a value at the same time

method Writer<W, (A Value, B Output)> Listens (Func<W, B> f) Source #

Listens executes the action and adds the result of applying f to the output to the value of the computation.

method Writer<W, A> Censor (Func<W, W> f) Source #

Censor executes the action and applies the function f to its output, leaving the return value unchanged.

method Writer<W, A> Lift (Pure<A> monad) Source #

Lifts a given monad into the transformer

Parameters

param	monad	Monad to lift
returns	`Writer`

method Writer<W, A> Lift (Func<A> f) Source #

Lifts a function into the transformer

Parameters

param	f	Function to lift
returns	`Writer`

method Writer<W, B> Map (Func<A, B> f) Source #

Maps the bound value

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`Writer`

method Writer<W, B> Select (Func<A, B> f) Source #

Maps the bound value

Parameters

type	B	Target bound value type
param	f	Mapping transducer
returns	`Writer`

method Writer<W, B> Bind (Func<A, K<Writer<W>, B>> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`Writer`

method Writer<W, B> Bind (Func<A, Writer<W, B>> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`Writer`

method Writer<W, Unit> Bind (Func<A, Tell<W>> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`Writer`

method Writer<W, C> SelectMany <B, C> (Func<A, K<Writer<W>, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`Writer`

method Writer<W, C> SelectMany <B, C> (Func<A, Writer<W, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`Writer`

method Writer<W, C> SelectMany <B, C> (Func<A, Pure> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`Writer`

method Writer<W, C> SelectMany <C> (Func<A, Tell<W>> bind, Func<A, Unit, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`Writer`

method (A Value, W Output) Run () Source #

Run the writer

Parameters

returns

Bound monad

class WriterExtensions Source #

Methods

method Writer<W, A> As <W, A> (this K<Writer<W>, A> ma) Source #

where W : Monoid<W>

method Writer<W, A> Flatten <W, A> (this Writer<W, Writer<W, A>> mma) Source #

where W : Monoid<W>

Monadic join

class Writer <W> Source #

Methods

method Writer<W, A> Pure <A> (A value) Source #

class Writer Source #

Methods

method Writer<W, A> Pure <W, A> (A value) Source #

where W : Monoid<W>

method Writer<W, B> bind <W, A, B> (Writer<W, A> ma, Func<A, Writer<W, B>> f) Source #

where W : Monoid<W>

method Writer<W, B> map <W, A, B> (Func<A, B> f, Writer<W, A> ma) Source #

where W : Monoid<W>

method Writer<W, B> apply <W, A, B> (Writer<W, Func<A, B>> mf, Writer<W, A> ma) Source #

where W : Monoid<W>

method Writer<W, B> action <W, A, B> (Writer<W, A> ma, Writer<W, B> mb) Source #

where W : Monoid<W>

method Writer<W, Unit> tell <W> (W item) Source #

where W : Monoid<W>

Tell is an action that produces the writer output

Parameters

type	W	Writer type
param	item	Item to tell
returns	Structure with the told item

method Writer<W, A> write <W, A> ((A, W) item) Source #

where W : Monoid<W>

Writes an item and returns a value at the same time

method Writer<W, A> write <W, A> (A value, W item) Source #

where W : Monoid<W>

Writes an item and returns a value at the same time

method Writer<W, A> pass <W, A> (Writer<W, (A Value, Func<W, W> Function)> action) Source #

where W : Monoid<W>

pass is an action that executes the action, which returns a value and a function; it then returns a the value with the output having been applied to the function.

method Writer<W, (A Value, W Output)> listen <W, A> (Writer<W, A> ma) Source #

where W : Monoid<W>

listen is executes the action ma and adds the result of applying f to the output to the value of the computation.

method Writer<W, (A Value, B Output)> listens <W, A, B> (Func<W, B> f, Writer<W, A> ma) Source #

where W : Monoid<W>

listens is executes the action ma and adds the result of applying f to the output to the value of the computation.

method Writer<W, A> censor <W, A> (Func<W, W> f, Writer<W, A> ma) Source #

where W : Monoid<W>

censor is executes the action ma and applies the function f to its output, leaving the return value unchanged.

class Writer <W> Source #

where W : Monoid<W>

MonadStateT trait implementation for StateT

Parameters

type	S	State environment type
type	M	Given monad trait

class Prelude Source #

Methods

method Writer<W, Unit> tell <W> (W item) Source #

where W : Monoid<W>

Tell is an action that produces the writer output

Parameters

type	W	Writer type
param	item	Item to tell
returns	Structure with the told item

method Writer<W, A> write <W, A> ((A, W) item) Source #

where W : Monoid<W>

Writes an item and returns a value at the same time

method Writer<W, A> write <W, A> (A value, W item) Source #

where W : Monoid<W>

Writes an item and returns a value at the same time

method Writer<W, A> pass <W, A> (Writer<W, (A Value, Func<W, W> Function)> action) Source #

where W : Monoid<W>

pass is an action that executes the action, which returns a value and a function; it then returns a the value with the output having been applied to the function.

method Writer<W, (A Value, W Output)> listen <W, A> (Writer<W, A> ma) Source #

where W : Monoid<W>

listen is executes the action ma and adds the result of applying f to the output to the value of the computation.

method Writer<W, (A Value, B Output)> listens <W, A, B> (Func<W, B> f, Writer<W, A> ma) Source #

where W : Monoid<W>

listens is executes the action ma and adds the result of applying f to the output to the value of the computation.

method Writer<W, A> censor <W, A> (Func<W, W> f, Writer<W, A> ma) Source #

where W : Monoid<W>

censor is executes the action ma and applies the function f to its output, leaving the return value unchanged.